Object::InspectorId

Section: ET++ method description (n)
Updated: automatically Fri Mar 1 10:54:57 1991
Index Return to Main Contents
 

NAME

Object::InspectorId - instance method  

TEMPLATE

void InspectorId(char * displayedName, int maxSize)  

SPECIFIERS

public virtual  

DESCRIPTION

InspectorId sets displayedName to a value that will eventually be displayed by the tools of the Programming Environment as an additional information when presenting the receiver to the user, e.g. in a list box of the Inspector. Objects of the same class can therefore be easily identified by the user, provided the displayedName's are meaningful.
The default implementation sets displayedName to "". There is no need to override this method (but it is a good good idea).

See method Document::InspectorId, method TextItem::InspectorId, method Collection::InspectorId for interesting examples. Method is often overridden.  

ARGUMENTS

char * displayedName

a null-terminated string
int maxSize

the available number of characters in displayedName
inclusive the terminating zero character
 

RETURN ARGUMENT

void

 

CATEGORIES

progenv support, overrider interface

 

FIRST DEFINITION

class Object  

FILES

implementation:
Object.C


 

Index

NAME
TEMPLATE
SPECIFIERS
DESCRIPTION
ARGUMENTS
RETURN ARGUMENT
CATEGORIES
FIRST DEFINITION
FILES

This document was created by man2html, using the manual pages.
Time: 00:40:25 GMT, March 30, 2022